/*
 * Copyright 2010 Biz-e (info@biz-e.nl)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nl.biz_e.gwt.baselib.validation.client;

import java.util.Vector;

import com.google.gwt.user.client.ui.FocusWidget;

/**
 * TODO: Write type comment
 * 
 * @author Joost A. Bloemsma
 */
public interface ValidationProcessor {
	/**
	 * Validates all registered objects
	 * 
	 * @return true if all passed
	 */
	public boolean validate();
	
	/**
	 * Adds a Widget/Validator combination. The widget will be validated with
	 * the passed
	 * validator when {@link #validate()} is called.<br/>
	 * <br/>
	 * A widget can be combined with several validators simply by registering it
	 * multiple times.
	 * 
	 * @param widget
	 * @param validator
	 */
	public void addValidator(FocusWidget widget, Validator validator);
	
	/**
	 * returns all messages generated by the last validation session
	 * 
	 * @return Vector
	 */
	public Vector<String> getMessages();
	
	/**
	 * Clears all messages and prepares the processor for a new validation round
	 */
	public void reset();
	
	/**
	 * If set to true, the validation will hold on the first failure.
	 * 
	 * @param halt
	 */
	public void setHaltOnFail(boolean halt);
}
